home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / misc / amicvs1-0.lha / AmiCVS / ReadMe < prev    next >
Encoding:
Text File  |  1995-02-17  |  7.0 KB  |  200 lines
  1. ===========================================================================
  2. This file gives you some information about the package AmiCVS.
  3. AmiCVS is a port of the CVS and the PCL-CVS package for the Amiga system.
  4.  
  5. Current version:  AmiCVS 1.0 by Reiner B. Nix
  6. ===========================================================================
  7.  
  8.  
  9. Contents
  10. --------
  11.  · What is CVS?
  12.  · Additional required stuff
  13.  · Contents of this package
  14.  · Installing the package
  15.  · Limitations and remarks
  16.  · Original packages and places to get them
  17.  · Copyright
  18.  · Thanks
  19.  · The authors address
  20.  
  21.  
  22.  
  23. What is CVS?
  24. ------------
  25.   CVS is a software version control system for program sources and
  26.   binaries. It is built on top of the RCS package extending and
  27.   simplifying it. Therefore you need an installed RCS package. CVS can
  28.   be used from shell or GNU Emacs with the PCL-CVS package.
  29.  
  30.  
  31. Additional required stuff
  32. -------------------------
  33.   As mentioned before, CVS is built on top of RCS in a way that it
  34.   calls the RCS executable programms. You need a version of the RCS
  35.   package, e.g. HWGRCS the well ported RCS package for Amiga by
  36.   Heinz Wrobel.
  37.  
  38.   To recompile the cvs program, you need a C compiler (e.g. gcc 2.3.3)
  39.   and yacc (e.g. bison 1.21) when changing the file AmiCVS/lib/getdate.y.
  40.  
  41.  
  42. Contents of this package
  43. ------------------------
  44.   AmiCVS/ReadMe.Amiga            :this documentation file you're reading
  45.   AmiCVS/dok/*                :documentation for cvs and pcl-cvs
  46.  
  47.   AmiCVS/bin/cvs            :the cvs executable program
  48.   AmiCVS/Rexx/CollectLog.cvs        :an ARexx script building a global log file
  49.  
  50.   AmiCVS/s/user-startup.add        :sample of additional entries for your s:user-startup file
  51.   AmiCVS/libs                :some libraries (implicid) used by the ARexx script
  52.  
  53.   AmiCVS/Repository            :a sample repository
  54.   AmiCVS/Repository/CVSlogfiles        :empty dir, it will later contain the global log files
  55.   AmiCVS/Repository/CVSroot        :sample administration files required by cvs
  56.   AmiCVS/Repository/CVSheaders        :sample cvs headers to include into your source files
  57.   
  58.   AmiCVS/emacs                :stuff to support cvs by GNU emacs
  59.   AmiCVS/emacs/lisp-adds        :directory to collect all non-standard add-ons
  60.   AmiCVS/emacs/lisp-adds/pcl-cvs/*    :ported files for the pcl-cvs mode
  61.   AmiCVS/emacs/lisp-adds/user-lisp/*    :user specific setting files
  62.   AmiCVS/emacs/.emacs-add        :extension of your s:.emacs to load the other adds
  63.   
  64.   AmiCVS/lib                :ported source for the cvs lib (just a linker library)
  65.   AmiCVS/scr                :ported source for the cvs program
  66.  
  67.  
  68. Installing the package
  69. ----------------------
  70.  · This file gives only brief hints to the ported cvs package using
  71.    the sample files. For more information:
  72.      on CVS see AmiCVS/dok/cvs.guide in this package,
  73.      on PCL-CVS see AmiCVS/dok/pcl-cvs.guide and
  74.      on RCS see README.guide in your RCS package if you're using HWGRCS.
  75.  
  76.  
  77.  · First, install the RCS package. Supposing you're using HWGRCS no
  78.    further installation than copying the package to GNU:hwg-rcs8 is
  79.    neccessary. You may choose another location and adapt the file
  80.    pathes latter.
  81.    
  82.  
  83.  · Choose a place for the package and copy the files. On my system
  84.    there is a symbolic volume GNU: where AmiCVS is located: GNU:AmiCVS.
  85.  
  86.  · Choose a place for the repository and copy the whole tree
  87.    AmiCVS/Repositiory to this place. It is a well idea of security to
  88.    select another partition than your common work partition!
  89.  
  90.  · Include the file AmiCVS/s/user-startup.add into your s:user-startup
  91.    and adapt the path entries matching your system if you have choosen
  92.    other ones.
  93.  
  94.  · Copy the libraries AmiCVS/libs/#? to Libs:
  95.    *** Beware that you don't replace newer versions ***
  96.    *** of this libraries if they already exists! ***
  97.  
  98.  · Copy the file AmiCVS/rexx/CollectLog.cvs to Rexx:
  99.  
  100.    
  101.  · If your're using the GNU emacs editor you can install PCL-CVS with
  102.    the following steps:
  103.  
  104.  · Append the file AmiCVS/emacs/.emacs-add to your s:.emacs
  105.  
  106.  · Copy the tree AmiCVS/emacs/lisp-adds to GNUemacs:lisp-adds
  107.  
  108.  · Adapt the path entries in the file
  109.    GNUemacs:lisp-adds/user-lisp-pcl-cvs-settings.el matching your 
  110.    system if you have choosen other ones. This requieres
  111.    byte-compiling this file after doing the changes: type
  112.      "M-x byte-compile-file".
  113.  
  114.    
  115.  · Now, you have to reboot to activate the changes in your s:user-startup.
  116.  
  117.  
  118. Limitations and remarks
  119. -----------------------
  120.   · The cvs program needs a stack of 50.000 to 100.000 bytes to run
  121.     reliable. Otherwise you'll get enoying error messages like
  122.     "floating point exception" or the system may crash!
  123.  
  124.   · Due to the fact that cvs is compiled with gcc, the GNU C compiler,
  125.     and HWGRCS is using SAS C some problems exists with path names.
  126.     Please don't set the environment variable CVSROOT to directly to a
  127.     volume name!
  128.  
  129.   · Be aware that the programs comes from Unix systems. This causes
  130.     some unexpected behavior of the programs dealing with file names.
  131.     On Unix systems file names are case sensitiv on Amiga not.
  132.     For example:
  133.       "cvs ceckout cvsroot"
  134.       ;this works well nevertheless the module is named CVSROOT
  135.  
  136.       "cvs release cvsroot"
  137.       ;this fails due to the unknown module name
  138.  
  139.       "cvs release CVSROOT"
  140.       ;this fails due to the wrong directory name
  141.  
  142.  
  143.   · The original sources of cvs package version 1.3 residing in the
  144.     GNU locations had to be adapted (using gcc version 2.3.3):
  145.       - the installation procedure don't match the amiga system,
  146.       - the makefiles aren't able to run,
  147.       - some configuration in src/config.h had to be done,
  148.       - there occured an compilation error in cvs.h.
  149.  
  150.   · The original sources of pcl-cvs version 1.05 and the contribution
  151.     comming with the editor xemacs are merged to get a complete
  152.     PCL-CVS package running on the GNU emacs, version 18.58, Amiga
  153.     port 1.26DG. They had to be adapted due to several unix specific
  154.     things. See AmiCVS/emacs/user-lisp/pcl-settings.el and
  155.     AmiCVS/emacs/pcl-cvs/pcl-cvs for more details.
  156.  
  157.  
  158. Original packages and places to get them
  159. ----------------------------------------
  160.   hwgcvs8    on AMINET
  161.   cvs1-3     from ftp@ftp.prep.ai.mit.edu    in pub/gnu (or other GNU locations)
  162.   pcl-cvs1.05    from ftp@ftp.lysator.liu.se    in pub/emacs
  163.   cvs-texi-0.07    from ftp@ftp.lysator.liu.se    in pub/emacs
  164.  
  165.   
  166. Copyright
  167. ---------
  168.   As not other declaimed, this package and all it's files are beyond
  169.   the gnu general public license, see AmiCVS/doc/cvs.guide for
  170.   details. Have a look to the components and their own copyrights
  171.   mentioned in the original packages.
  172.  
  173.  
  174. Thanks
  175. ------
  176.   I wish to thank all the people involved with the CVS stuff,
  177.   namely and in alphabetical order:
  178.   
  179.     Brian Berliner and Jeff Polk for CVS,
  180.     Per Cederqvist for the emacs mode pcl-cvs and the cvs texinfo documentation,
  181.     David Gay for the Amiga port of GNU emacs,
  182.     Markus M. Wild for the Amiga port of gcc,
  183.     Heinz Wrobel for the Amiga port of RCS
  184.     
  185.   All of them wrote great stuff making this package possible!
  186.  
  187.  
  188. The authors adress
  189. ------------------
  190.  Feel free to send my remarks, questions, bug reports ...
  191.  
  192.  snail mail:
  193.    Reiner B. Nix
  194.    Roermonder Straße 112a, App. 60
  195.    52072 Aachen
  196.    Germany
  197.  
  198.  email:
  199.    rbnix@pool.informatik.rwth-aachen.de
  200.